home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 June / EnigmA AMIGA RUN 19 (1997)(G.R. Edizioni)(IT)[!][issue 1997-06][EAR-CD III].iso / games / interactivefiction / agt / readme.agility < prev    next >
Text File  |  1996-10-23  |  9KB  |  198 lines
  1. =================================================
  2. AGILITY: THE (MOSTLY) UNIVERSAL AGT INTERPRETER
  3. Version 0.3 (beta)
  4. =================================================
  5.  
  6.   This is an interpreter for game files created with Malmberg and
  7. Welch's _Adventure Game Toolkit_. AGiliTy is universal in the sense
  8. that it understands and interprets most of the many versions of the
  9. AGT game file format (unlike the original interpreters which were
  10. only intended to run the game file format associated with them) and
  11. also in that it is written in ANSI C and so should be straightforward
  12. to port to other systems.
  13.  
  14.   It is *not* a port of the original interpreters but rather a
  15. completely new interpreter built around the game file format; while it
  16. follows the original interpreters on most things, there are some
  17. differences which are described below.
  18.  
  19.    This software is copyright 1996 by Robert Masenten but may be
  20. freely distributed and used for non-commercial purposes so long as
  21. this file (and hence this copyright notice) is included
  22. unaltered. Since this is a beta version, I ask that this not be placed
  23. on FTP sites or BBSs other than the Interactive Fiction archive at
  24. ftp.gmd.de and its mirrors.
  25.   Since this is free software, it has NO WARRANTY of any kind.
  26.  
  27.   For information on compiling and porting this program, see the file
  28. 'agility.doc'. A list of known bugs is in the file 'buglist' and a
  29. list of changes from earlier versions is in 'changes.txt'. (If this is
  30. with a binary and not the source version, some of these files may not
  31. be present).
  32.  
  33.    Send comments and bug reports to Robert Masenten at:
  34.     masenten@math.upenn.edu.
  35.  
  36.  
  37. -----------------
  38. ACKNOWLEDGMENTS
  39. -----------------
  40. Thanks to the following people:
  41.  *David Kinder (responsible for the Amiga port and a source of much
  42. valuble feedback)
  43.  *Jay Goemmer (who has contributed several ideas for improvements)
  44.  *Robert Pelak (who suggested the name "AGiliTy") 
  45.  *All of the other people on rai-f who suggested names for my interpreter.
  46.  
  47.  
  48. -----------------------
  49. AGT VERSIONS SUPPORTED
  50. -----------------------
  51.   AGiliTy is known to understand the following versions of AGT (which
  52. include almost every AGT game at ftp.gmd.de):
  53.   --1.18
  54.   --the early 'Classic AGT': e.g. 1.19, 1.2, 1.21 
  55.   --"Classic AGT", both big and small: e.g. 1.3, 1.32, 1.35, 1.5, 1.7
  56.   --the "Even Bigger 1.32" used by _Cosmoserve_
  57.   --the "Chemically Altered 1.32" used by _Shades of Gray_, 
  58.   --Menichelli's 1.82 and 1.83 (only minimally tested)
  59.   --Both known "pre-Master's" 1.5 variants
  60.   --The "Master's Edition", versions 1.0, 1.55, and 1.56/1.6. 
  61.  
  62.   AGiliTy can't currently read version 1.0 games as these use an earlier
  63. form of the opcode encoding scheme that I haven't finished
  64. deciphering. AFAIK the only game on ftp.gmd.de affected by this is _The
  65. Spatent Obstruction_.
  66.    _Klaustrophobia_ is technically supported but is written in multiple
  67. chapters; while AGiliTy can be used to play the first chapter, the
  68. game depends on DOS programs to switch between chapters (apparently by
  69. doing some magic with save files). 
  70.  
  71.    _The Pyrmaids of Mars_ and _Cliff Diver_ require configuration
  72. options to be set since they use variant interpreters that
  73. are supported but can't be detected by the interpreter.
  74.   _Pyramids_ needs the ALT_ANY option to be set and _Cliff Diver_
  75. requires the IRUN option.
  76.  
  77.  
  78. -----------------------------------------------------------
  79. DIFFERENCES BETWEEN AGILITY AND THE ORIGINAL INTERPRETERS
  80. -----------------------------------------------------------
  81.  --Disambiguation is done on the normal command entry line rather than
  82. having a special prompt.
  83.  --LISTEXIT ON, LISTEXIT OFF will turn automatic listing of exits on or
  84. off (in AGT there is a LIST EXITS command, so some AGT games fail to
  85. list exits to a room).
  86.  --OOPS, UNDO, and RESTART are supported (at least on systems with
  87. enough memory).
  88.  --Adjective-only matches are accepted by the parser.
  89.  --Some more multiple word verbs are automatically recognized (for
  90. example, GET IN is automatically translated into ENTER).
  91.  --Some built-in verbs have additional synonyms. (In particular,
  92. standard one-letter abbreviations are supported: X for EXAMINE, Z for
  93. WAIT)
  94.  --The standard error messages are different than the original (except
  95. in Master's Edition games where most of the standard error messages
  96. are included in the game file)
  97.  --SCRIPT output is sent to a file rather than to the printer.
  98.  --AGiliTy has an extended AGILDEBUG debugging verb and supports more
  99. detailed metacommand debugging output.  
  100.  --AGiliTy uses a different save file format.  
  101.  --COLORS is not supported, although on some systems equivilant
  102. functionality may be supported in the configuration file. 
  103.  --Graphics, sound, and fonts are not supported (although the remaining
  104. Master's Edition language extensions are).
  105.  
  106.  
  107. ----------------------
  108. LIST OF SPECIAL VERBS
  109. ----------------------
  110. These are all of the special verbs recognized by the interpreter:
  111. SCORE    Print out your score.
  112. NOTIFY    Turn score notification on and off
  113. BRIEF   Don't print room descriptions for rooms you've seen.
  114. VERBOSE Print room descriptions even  for rooms you've already seen.
  115. LIST EXITS List the exits from a room.
  116. LISTEXIT ON,OFF     Turn on/off automatic listing of exits.
  117. SCRIPT    Start sending a transcript to a file.
  118. UNSCRIPT  Stop creating a transcript.
  119. LOG    Start sending all of your commands to a file.
  120. REPLAY <number>  Replay your commands from a file, one every <number>
  121.     seconds.
  122. REPLAY STEP  Replay your commands from a file, one for every keypress.
  123. AGILDEBUG  Access debugging commands.
  124. MENU    Toggle menu mode on or off.
  125. OOPS    Correct a word you just mistyped; must be the first command on
  126.     a line.
  127. UNDO    Undo your last move; must be the first command on a line.
  128. SAVE    Save the game.
  129. RESTORE    Restore the game.
  130. RESTART    Restart the game.
  131. QUIT    Quit 
  132.  
  133.  
  134. --------------------
  135. CONFIGURATION FILES
  136. --------------------
  137.  The following configuration options are supported on all platforms.
  138. Other options may be supported on your particular system; see any
  139. platform-specific notes for information.
  140.   Each option should be on a separate line in the configuration file.
  141. Lines starting with '#' will be treated as comments and ignored.
  142. Options can be negated by prefixing them with 'NO_' so that, for
  143. example, DEBUG would become NO_DEBUG.
  144.  
  145. General options:
  146.   VERBOSE  Start the game in VERBOSE mode
  147.   DEBUG    Allow the use of AGILDEBUG for pre-Master's games
  148.   PATH  Gives a space-separated search path for AGT games. (not
  149.     implemented yet)
  150.   TONE  Enables the *tone* action token, which allows games to make annoying
  151.     beeps on some platforms.  The only game I would recommend
  152.     enabling this for is  _CosmoServe_ which has some interesting
  153.     sound effects.  Not all platforms support this command.
  154.   INPUT_BOLD  Makes the input line bold. (This doesn't work on all 
  155.     platforms yet)
  156.   
  157.  
  158. Game specific options
  159.   ROOMTITLE  Print the room title in bold before the room  description 
  160.     in pre-Master's games. (Master's Edition games do this 
  161.     automatically)
  162.   IRUN  Print error messages in first person. This should be set for 
  163.     _Cliff Diver_.
  164.   CONST_TIME  Increment time at a constant rate instead of randomly.  
  165.   SLASH_BOLD  If set the slash character toggles bold on and off.
  166.     (This is set automatically for 1.8x games)
  167.   PRONOUN_SUBS  Do $you$-style substitutions even in  game-author 
  168.     defined messages. 
  169.   ALT_ANY This scans the ANY metacommands *with* the <verb>
  170.     metacommands rather than before them.  Should be set for
  171.     _Pyramids of Mars_. 
  172.  
  173. Technical options: These are fine tuning.
  174.   FIX_METAVERB  Don't run ANY metacommands when executing a metaverb.
  175.   FIX_MULTINOUN      Only advance one turn when manipulating multiple nouns,
  176.     rather than a turn for each noun.
  177.   PURE_ANSWER   Require AND-connected answers to be in the right order.
  178.     (The ME documentation claims order shouldn't matter, but in 
  179.     the actual interpreters it does.)
  180.  
  181.     
  182. Parse Options: These are all pretty technical.
  183.   PURE_DUMMY   Allow dummy verbs to be run by typing "dummy_verb3"
  184.   PURE_SUBNAME Allow subroutines to be run by typing "subroutine3"
  185.   PURE_SYNONYM Treat synonyms exactly as nouns.
  186.   ADJ_NOUN     Don't pick noun matches over adjective-only matches.
  187.   
  188.  
  189. -------------------
  190. DEBUGGING OPTIONS
  191. -------------------
  192.   With AGILDEBUG you can access various debugging commands.  You can
  193. move objects around; change the values of flags, variables and
  194. counters; list objects in the game; examine and edit objects; and turn
  195. metacommand debugging on or off.
  196.   When metacommand debugging is on, every metacommand that is run will
  197. be displayed. 
  198.